Quick setup documentation v1.0

---

Houzi - real estate app

---

Table of Contents

1. Setup Website
2. Install Houzi Rest Api Plugin
3. Flutter Setup
4. Connect App to your website
5. Compile and Run App
6. Detailed Documentation

---

Setup Website

This app works with Houzez Wordpress theme. You need to install Houzez on your wordpress website. Download and Setup Houzez from here: Houzez Real Estate Wordpress Theme.
If you already have Houzez setup and installed, you can continue to next configurations.

---

Install Houzi Rest Api Plugin

Houzi Rest Api is a wordpress plugin that extends the default rest api functionality of Houzez theme to mobile apps. You can download here: Houzi Rest Api. Install and activate.

---

Flutter Setup

This app is a Flutter application, which means it requires Flutter SDK setup on your platform. Download the Flutter SDK version 3.0.5 for your platform from below URL:
Flutter for Windows
Flutter for MacOS
Go to Flutter Get Started, and follow setup instructions.
Android Studio or VSCode can be used to edit the code.

---

Connect App to your website

After downloading the sdk, its time to connect the app to your website.
Unzip houzi-xxx.zip from flutter-app folder and open the app code folder in your preferred IDE.
There're two ways to connect to your website.

Connect website by editing config.json

Open the Project_HOME > assests > configuration > configuration.json file, and look for wordpress_url_domain and Replace with your own domain and scheme.

//Mandatory
"wordpress_url_scheme": "https",
"wordpress_url_domain": "domain.com",
"wordpress_url_path": "",

if your website URL does not contain a subpath then leave wordpress_url_path as it is.

Connect website using Houzi Builder

You can use Houzi Builder to configure your app.
Please follow these steps for the quick setup of your Mobile app.

1. Open the Houzi Builder application.
2. Provide App Name in the required field.

3. Provide Wordpress URL in the required field.

   Note: To provide Wordpress URL, just click on Wordpress URL Text Field. A dialog will open. Provide the Wordpress URL Scheme, Wordpress URL Domain and Wordpress URL Path in their respective fields.
   If your website URL does not contain a subpath then leave Wordpress URL Path field as it is.

   

   Example 1 (Website Url with path):
   Url: https://domain.com/path/
   Wordpress URL Scheme = https
   Wordpress URL Domain = domain.com
   			

4. Provide other URLs.
5. Export and copy the text and replace all text in following file: the Project_HOME > assests > configuration > configuration.json file.

---

Compile and Run App

After following the minimum required steps to connect to your website, you are now able to compile app to view your app in action.

Detailed Documentation

This is a quick setup guide. We have detailed documentation available at Houzi-Docs.